Fetch Pix Scheduling

Consultar todos os Pix Automáticos agendados

Requisição

GET 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/scheduling'

Cabeçalhos

Nome	Descrição
Authorization	Obrigatório. Chave da API

Parâmetros de Query

Nome	Tipo	Descrição
flow	number	Obrigatório. Qual fluxo buscar: 0 para pagador ou 1 para recebedor
beneficiaryDocument	string	Opcional. Documento do recebedor (máx. 14 caracteres)
payerPersonType	number	Opcional. Tipo de pessoa: 0 para Pessoa Física, 1 para Pessoa Jurídica
payerDocument	string	Opcional. Documento do pagador (máx. 14 caracteres)
status	string	Opcional. Status do agendamento
dueDateStart	date	Obrigatório. Data inicial da consulta (formato Date)
dueDateEnd	date	Obrigatório. Data final da consulta (formato Date)
page	number	Opcional. Número da página (Padrão: 1). Deve ser um número positivo
pageSize	number	Opcional. Quantidade de resultados por página (Padrão: 50, Máx: 100)

Resposta

O status code 200 indica sucesso na consulta.

Em caso de sucesso, o retorno terá os seguintes campos em formato JSON:

{
    "data": [
        {
            "endToEndId": "E3822485720250610120000010000001",
            "beneficiaryConciliationId": "RR4002892220250429ABCDE122131",
            "scheduleStatus": "ACCEPTED",
            "acceptRejectAt": "0001-01-01T00:00:00Z",
            "requestAt": "2025-06-10T16:08:21.284Z",
            "situationAt": "2025-07-11T15:03:32.027Z",
            "processingStatus": "PENDING_USER",
            "status": "PROCESSING",
            "errorCode": null,
            "errorCodeDescription": null,
            "recurrenceId": "RR4002892220250429ABCDE122131",
            "beneficiaryPspReceivedAt": "2025-06-10T15:54:39.494Z",
            "dueDate": "2025-06-12",
            "amount": 150.75,
            "beneficiary": {
                "ispb": "38224857",
                "document": "03284584000162",
                "name": "corporateName",
                "branchNumber": "0001",
                "accountType": "PAYMENT",
                "accountNumber": "99999"
            },
            "payer": {
                "ispb": "38224857",
                "type": "NATURAL",
                "document": "12345678901",
                "branchNumber": "0001",
                "accountNumber": "99998"
            },
            "infoBetweenCustomers": "Contrato: Teste Alisson - Assinatura Exclusive Ultra",
            "schedulePurpose": "FIRST_ATTEMPT",
            "cancellations": [
                {
                    "cancellationId": "CA3822485720250616Jgs0xZD3uAV",
                    "requesterIspb": "38224857",
                    "recipientIspb": "38224857",
                    "cancellationRequesterType": "LEGAL",
                    "cancellationRequesterDocument": "03284584000162",
                    "cancellationReason": "REQUESTED_BY_PAYEE",
                    "cancellationAt": "2025-06-16T17:08:36.679Z",
                    "cancellationStatus": "ACCEPTED",
                    "errorCode": null,
                    "errorCodeDesc": null
                }
            ]
        }
    ],
    "pagination": {
        "pageNumber": 1,
        "pageSize": 50,
        "totalPages": 1,
        "totalRecords": 1,
        "hasPreviousPage": false,
        "hasNextPage": false
    }
}